Получение информации о лимите

Запрос позволяет получить информацию по конкретному лимиту.

Синтаксис запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/limits?limit_id={ID лимита}

Заголовки запроса

Authorization: Bearer <OAuth-токен>
Процесс получения токена описан в разделе Начало работы.

X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос может содержать следующие необязательные параметры:

limit_id - ID запрашиваемого лимита.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле	Описание	Формат
`id`	id лимита.	Строка
`title`	Название лимита.	Строка
`client_id`	id клиента.	Строка
`department_id`	id департамента, к которому относится лимит. Если департамент отсутствует, значит, это корневой департамент.	Строка
`categories`	Cписок доступных тарифных категорий. Указывается только для сервисов `taxi` и `cargo`. Формат списка "категория1","категория2", ....	Массив строк
`fuel_types`	Список доступных видов топлива. Указывается только для сервиса `tanker`. Формат списка "вид1","вид2", ....	Массив строк
`limits`	Ограничения	Объект
`geo_restrictions`	Блок с информацией о разрешенных районах поездок.	Массив объектов
`time_restrictions`	Блок с информацией о временных ограничениях.	Массив объектов
`can_edit`	Признак, может ли пользователь изменить или удалить данный лимит.	Логическое
`counters`	Количество сотрудников с данным лимитом. Объект со структурой `{"users": <число>}`.	Объект
`is_default`	Признак, используется ли данный лимит по умолчанию (задан при активации сервиса клиенту).	Логическое
`is_qr_enabled`	Включена ли оплата по QR (только для сервисов Еда и Лавка).	Логическое
`service`	Идентификатор сервиса, для которого задается лимит.	Строка
`cities`	Города, в которых можно использовать сервис (только для сервиса Драйв).	Массив объектов
`tariffs`	Тарифы, доступные к заказу (только для сервиса Драйв).	Массив объектов
`cars_classes`	Машины, доступные к заказу (только для сервиса Драйв).	Логическое
`enable_toll_roads`	Разрешен ли проезд по платным дорогам (только для сервисов Такси и Драйв).	Логическое

Структура объекта limits:

Поле	Описание	Формат
`orders_amount`	Ограничение на число поездок, которые клиент может совершить за период. Указывается только для сервисов `taxi` и `cargo`. Объект со структурой `{"value": <число>, "period": <период>}`. Период задается в виде строки, например, `"month"`.	Объект
`orders_cost`	Ограничение на сумму, которую клиент может потратить за период. Объект со структурой `{"value": <число>, "period": <период>}`. Период задается в виде строки, например, `"month"`.	Объект

Структура элемента массива geo_restrictions:

Поле	Описание	Формат
`source`	Идентификатор района начала поездки. Если поле не задано, то разрешен любой район. Должно быть задано хотя бы одно из полей `source` и `destination`.	Строка
`destination`	Идентификатор района конца поездки. Если поле не задано, то разрешен любой район. Должно быть задано хотя бы одно из полей `source` и `destination`.	Строка

Структура элемента массива time_restrictions:

Поле	Описание	Формат
`type`	Тип ограничения. Возможные значения: `weekly_date` — ограничения по дням недели. `range_date` — ограничения по дате.	Строка
`days`	Дни недели, в которые доступен заказ поездки. Возможные значения: `mo` — понедельник. `tu` — вторник. `we` — среда. `th` — четверг. `fr` — пятница. `sa` — суббота. `su` — воскресенье. Поле используется только для ограничения с типом `weekly_date`.	Массив строк
`start_time`	Время, начиная с которого будет доступен заказ. Формат значений: `ЧЧ:ММ:СС`. Поле используется только для ограничения с типом `weekly_date`.	Строка
`end_time`	Время, до которого будет доступен заказ. Формат значений: `ЧЧ:ММ:СС`. Поле используется только для ограничения с типом `weekly_date`.	Строка

Пример запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/limits?limit_id=41...10
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Пример ответа

Пример ответа для сервиса Такси:

{
    "categories": [
        "cargo_hour",
        "child_tariff",
        "lite_b2b",
        "maybach",
        "minivan",
        "optimum_b2b",
        "premium_van",
        "standart_b2b",
        "ultimate",
        "vip"
    ],
    "time_restrictions": [],
    "geo_restrictions": [],
    "id": "41...10",
    "client_id": "a2...52",
    "service": "taxi",
    "title": "Такси",
    "limits": {},
    "counters": {
        "users": 1
    },
    "is_default": true,
    "enable_toll_roads": true,
    "can_edit": true
}

Пример ответа для сервиса Драйв:

{
    "id": "26...40",
    "client_id": "a2...52",
    "service": "drive",
    "title": "Поездки на каршеринге",
    "limits": {
        "orders_cost": {
            "value": "10000",
            "period": "month"
        }
    },
    "counters": {
        "users": 1
    },
    "is_default": true,
    "cities": [
        "kzn",
        "msk",
        "sochi",
        "spb"
    ],
    "tariffs": [
        "fix_offer_regular",
        "flexible_pack_offer",
        "intercity_offer",
        "standart_offer"
    ],
    "cars_classes": [
        "cargo",
        "everyday",
        "holiday",
        "shuttle"
    ],
    "enable_toll_roads": true,
    "time_restrictions": [],
    "can_edit": true
}

Пример ответа для сервисов Еда и Лавка:

{
    "id": "99...f7",
    "client_id": "a2...52",
    "service": "eats2",
    "title": "Обеды и перекусы",
    "time_restrictions": [
        {
            "type": "weekly_date",
            "start_time": "00:00:00",
            "end_time": "23:59:00",
            "days": [
                "sa",
                "su"
            ]
        },
        {
            "type": "weekly_date",
            "start_time": "00:00:00",
            "end_time": "23:59:00",
            "days": [
                "fr",
                "mo",
                "th",
                "tu",
                "we"
            ]
        },
        {
            "type": "weekly_date",
            "start_time": "00:00:00",
            "end_time": "23:59:00",
            "days": [
                "fr",
                "mo",
                "th",
                "tu",
                "we"
            ]
        },
        {
            "type": "weekly_date",
            "start_time": "00:00:00",
            "end_time": "23:59:00",
            "days": [
                "fr",
                "mo",
                "th",
                "tu",
                "we"
            ]
        }
    ],
    "geo_restrictions": [],
    "limits": {
        "orders_cost": {
            "value": "1000",
            "period": "month",
            "accumulation_rules": {
                "accumulation_period": "year"
            }
        }
    },
    "counters": {
        "users": 1
    },
    "is_default": true,
    "is_qr_enabled": false,
    "can_edit": true
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

200 — запрос выполнен успешно.
400 — запросе был передан неизвестный параметр или параметр с недопустимым значением.
403:
- SELECT_CLIENT_HEADER_REQUIRED — в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
- SELECTED_CLIENT_ACCESS_DENIED — в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
404 — лимит не найден.

Была ли статья полезна?

Получение списка лимитов клиента

Изменение персональных лимитов